Skip to content

Docs(Start): remove target from hosting docs #5204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 24, 2025
Merged

Docs(Start): remove target from hosting docs #5204

merged 1 commit into from
Sep 24, 2025

Conversation

@nlynzaad
Copy link
Contributor

@nlynzaad nlynzaad commented Sep 24, 2025 •
edited by coderabbitai bot
Loading

This removes reference to the target property from the hosting docs as this is now defined through vite plugins

Summary by CodeRabbit

  • Documentation
    • Revised React hosting guide to clarify deployment flow after selecting a target.
    • Reorganized hosting providers list; added options like Nitro and Node.js server, and aligned Cloudflare to Workers.
    • Updated instructions to favor generalized or plugin-based setup over target-specific directives.
    • Refreshed Cloudflare Workers guidance to use the recommended plugin approach.
    • Simplified Bun deployment notes to focus on validating configuration.
    • Removed outdated or redundant entries to streamline the guide.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 24, 2025 •
edited
Loading

Walkthrough

The React hosting documentation was revised to reword deployment guidance, reorganize hosting targets, and update provider-specific instructions (e.g., Cloudflare Workers, Bun) to favor plugin-based or generalized Vite configuration steps over target-specific directives.

Changes

Cohort / File(s) Summary of Changes
Docs — React hosting guide
docs/start/framework/react/hosting.md		 Rephrased intro guidance; reorganized hosting providers list (e.g., Cloudflare Workers instead of Pages; added Nitro, Node.js server, Bun); updated Cloudflare Workers to use a Vite plugin step; generalized Bun guidance to verify vite.config.ts; removed target-specific directives across sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • docs(start): fix broken links #5197 — Also updates the same React hosting doc with overlapping deployment-target guidance (Cloudflare Workers/Pages, Bun, anchors, Netlify), indicating closely related content changes.

Suggested labels

documentation

Poem

A rabbit taps keys with fleet little thumps,
Shuffles the clouds, tidies up bumps.
Targets no more—just plugins to steer,
Vite in the headlights, the pathway clear.
Hippity-hop, deploy without fright—
Docs now point true by dawn’s soft light. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Docs(Start): remove target from hosting docs" is concise and directly describes the primary change in the PR — removing references to the target property from hosting documentation — and aligns with the PR objectives and raw summary which describe replacing target-specific directives with plugin-based instructions. It is specific, readable, and useful for teammates scanning the repository history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove-target-from-hosting-docs
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 065722a and e53dda2.

📒 Files selected for processing (1)
  • docs/start/framework/react/hosting.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/start/framework/react/hosting.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/start/framework/react/hosting.md
🔇 Additional comments (4)
docs/start/framework/react/hosting.md (4)

19-19: LGTM! Clear documentation improvement.

The updated text effectively emphasizes following the deployment guidelines rather than configuring a specific target value, which aligns with the plugin-based approach mentioned in the PR objectives.

21-28: LGTM! Updated hosting provider list reflects current architecture.

The changes correctly replace the old target-based configuration with the plugin-based approach that TanStack Start now uses. The reorganization from Cloudflare Pages to Cloudflare Workers and the addition of more deployment targets (Nitro, Node.js server, Bun) provides better coverage of supported platforms.

46-46: LGTM! Plugin-based configuration is the correct approach.

The change from "Set the target value to cloudflare-module" to "Add the cloudflare plugin to your vite.config.ts" correctly reflects the new plugin-based configuration approach that TanStack Start now uses instead of the deprecated target property.

208-208: LGTM! Generic configuration guidance aligns with new architecture.

The change from "Set the target value to bun" to "Ensure your vite.config.ts is correct" follows the same pattern of removing target-specific directives in favor of generalized configuration guidance, which is consistent with the overall migration away from the target property approach.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the documentation Everything documentation related label Sep 24, 2025
@nx-cloud
Copy link

nx-cloud bot commented Sep 24, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit e53dda2

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 4s View ↗
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-09-24 08:41:04 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 24, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5204

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5204

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5204

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5204

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5204

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5204

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5204

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5204

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5204

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5204

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5204

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5204

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5204

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5204

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5204

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5204

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5204

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5204

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5204

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5204

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5204

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5204

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5204

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5204

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5204

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5204

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5204

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5204

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5204

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5204

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5204

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5204

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5204

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5204

commit: e53dda2

@nlynzaad nlynzaad merged commit 0683940 into main Sep 24, 2025
5 of 6 checks passed
@nlynzaad nlynzaad deleted the remove-target-from-hosting-docs branch September 24, 2025 08:42
This was referenced Nov 1, 2025
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Everything documentation related

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nlynzaad